Genius Scan SDK/com.geniusscansdk.core/ScanProcessor

ScanProcessor

class ScanProcessor(documentDetector: DocumentDetector, orientationDetector: OrientationDetector)

This class is used to apply a sequence of image operations on a picture: perspective correction, curvature correction and image enhancement. Each of these operations can be configured using a configuration object.

Constructors

ScanProcessor

constructor(context: Context)

constructor(documentDetector: DocumentDetector, orientationDetector: OrientationDetector)

Types

Companion

object Companion

Configuration

class Configuration<O>( perspectiveCorrection: ScanProcessor.PerspectiveCorrection, curvatureCorrection: ScanProcessor.CurvatureCorrection, enhancement: ScanProcessor.Enhancement, rotation: ScanProcessor.Rotation, readability: ScanProcessor.Readability = Readability.disabled(), outputConfiguration: ScanProcessor.OutputConfiguration<O>)

Parameters of the processing.

CurvatureCorrection

class CurvatureCorrection

Configuration for curvature correction.

Enhancement

class Enhancement

Configuration for image enhancement.

FilterStyle

enum FilterStyle : Enum<ScanProcessor.FilterStyle>

Style for the magic filter

OutputConfiguration

class OutputConfiguration<O>

Configuration controlling the output format of the processed image, either as a file or a bitmap.

OutputFileFormat

enum OutputFileFormat : Enum<ScanProcessor.OutputFileFormat>

PerspectiveCorrection

class PerspectiveCorrection

Configuration for perspective correction. When this configuration is enabled, perspective correction will be applied to the image, either using the result of the document detection, or the Quadrangle provided in this configuration.

Readability

class Readability

Configuration for the readability feature. When this configuration is enabled, the readability of the image will be estimated, possibly based on several parameters (eg sharpness, brightness…). This is especially suitable and accurate for text documents.

ReadabilityLevel

enum ReadabilityLevel : Enum<ScanProcessor.ReadabilityLevel>

Level of readability of the processed scan

Result

class Result<T>( val appliedQuadrangle: Quadrangle, val appliedFilter: FilterType?, val appliedFilterConfiguration: FilterConfiguration, val appliedRotation: RotationAngle, val readabilityLevel: ScanProcessor.ReadabilityLevel?, val output: T)

Result of the processing.

Rotation

class Rotation

Configuration for the orientation of the scan, which controls whether or not the orientation of the scan should be determined automatically, or if the scan should be processed with a specific rotation angle.

Functions

process

fun process(inBitmap: Bitmap, configuration: ScanProcessor.Configuration<Bitmap>): ScanProcessor.Result<Bitmap>

fun process(inputImage: File, configuration: ScanProcessor.Configuration<File>): ScanProcessor.Result<File>

Process image file using the given configuration.